This repository was archived by the owner on Mar 26, 2026. It is now read-only.
Update fundamentals package docs to current APIs#6
Merged
Conversation
Store:
- Replace all $-prefixed API with StoreApi<T> pattern
- Update examples to destructured { store, patch, subscribe }
- Update plugin type, API reference, testing patterns
Form:
- Add Accessor<T> = Signal<T> | Computed<T> type
- Update isValid/isDirty to Accessor<boolean>
- Add register type:'number' docs
Validation:
- Update ArkType to ArkTypeCallable (drop allows)
- Note PropertyKey[] paths for Zod v4 compat
- Note Function type for Valibot GenericSafeParseFn
Storybook:
- Expand from 137 to 527 lines
- Add Meta/StoryObj options, decorators, reactive stories,
interaction testing, renderToCanvas lifecycle, full example
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Auto-formatted api-card.tsx, package-badge.tsx, prop-table.tsx. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Update documentation for all fundamentals ecosystem packages to reflect the current API after the store redesign, type safety improvements, and validation duck-type changes.
Store — Major rewrite
$-prefixed API ($patch,$subscribe,$onAction,$reset,$dispose,$state,$id) withStoreApi<T>patternconst { store, patch, subscribe } = useCounter()Form
Accessor<T> = Signal<T> | Computed<T>type documentationisValid/isDirtyupdated toAccessor<boolean>register()now documents{ type: 'number' }optionValidation
ArkTypeCallable(any callable, noallowsmethod required)PropertyKey[]paths for v4 compatibilityFunctiontype forGenericSafeParseFnStorybook — Major expansion (137 → 527 lines)
🤖 Generated with Claude Code